Bundle org.nuxeo.ecm.platform.lang.ext

In bundle group org.nuxeo.ecm.platform.lang

Documentation

README.md
Nuxeo external translations

This module contains community-created translations, as well as some basic tools to help manage these translations.

How to update an existing translation?

If you want to participate to the translation process, please read the How to translate the Nuxeo Platform page.

The rest of this README is for developers that are maintaining this module according to Crowdin translation files. Note there is some tooling used to handle this module.

WARNING

All properties files in this module are managed automatically: except on edge cases, you should never push changes to these files on GitHub, otherwise they may be lost at next automated synchronization.

Note that only the master branch is handled by synchronization, manual changes are still needed on maintenance branches.

How to add a new language?
1. Set the new language as a new target language on Crowdin, and download the corresponding file.
Rename this translation file to messages_xx_XX.properties, where xx_XX is the 4 letters codename for your language, and reference it in the crowdin.ini file.
1. Create a Nuxeo Bundle and put your file under
```
 src/main/resources/web/nuxeo.war/WEB-INF/classes/
```
2. Modify the deployment-fragment.xml file accordingly:
```
 <?xml version="1.0"?>
 <fragment version="1">
   <require>org.nuxeo.ecm.platform.lang.ext</require>
   <extension target="faces-config#APPLICATION_LOCALE">
     <locale-config>
       <supported-locale>xx_XX</supported-locale> 
     </locale-config>
   </extension>
   <install>
     
     <unzip from="${bundle.fileName}" to="/" prefix="web">
       <include>web/nuxeo.war/**</include>
     </unzip>
     
     <copy from="nuxeo.war/WEB-INF/classes/messages_xx_XX.properties"
           to="nuxeo.war/WEB-INF/classes/messages_xx.properties"/>
   </install>
 </fragment>
```
Where to add your existing translations?

Here's the resolving order when looking for a label in Brazilian for instance.
```
messages_pt_BR.properties -> messages_pt_PT.properties -> messages_en.properties -> messages.properties
```
Brazilian is a 'dialect' of Portuguese, so there is first a fallback on Portuguese, then a fallback to the default language of the application ("en" for Nuxeo) then to messages.properties.

Most of the fallback is actually handled directly by Crowdin, the tool we use for translations. When downloading a file from Crowdin, like messages_pt_BR.properties for instance, the missing labels will be replaced by the ones from file messages_pt_PT.properties (if it exists), then by the reference English file used by Crowdin. This is why you'll see English translations by default in some non-English files.

What's with these two letter files like messages_pt.properties? Those are actually an automatic copy of the four letter version, purposed to provide a fallback when browser language is set to a two letter format. So you are not supposed to modify them, ever.

How to add custom translations to an existing language?

If you want to add your custom label translations to an existing language, you can contribute it to the main file holding all translations.
1. Take your messages_xx_XX.properties where xx_XX is the 4 letters codename for your language.
2. Create a Nuxeo Bundle and put your file under:
```
 src/main/resources/web/nuxeo.war/WEB-INF/classes/
```
3. Modify the deployment-fragment.xml file accordingly:
```
 <?xml version="1.0"?>
 <fragment version="1">
   <require>org.nuxeo.ecm.platform.lang.ext</require>
   <install>
     <delete path="${bundle.fileName}.tmp" />
     <mkdir path="${bundle.fileName}.tmp" />
     <unzip from="${bundle.fileName}" to="${bundle.fileName}.tmp" />
     
     <append from="${bundle.fileName}.tmp/web/nuxeo.war/WEB-INF/classes/messages_xx_XX.properties"
             to="nuxeo.war/WEB-INF/classes/messages_xx_XX.properties" addNewLine="true" />
     
     <append from="${bundle.fileName}.tmp/web/nuxeo.war/WEB-INF/classes/messages_xx_XX.properties"
             to="nuxeo.war/WEB-INF/classes/messages_xx.properties" addNewLine="true" />
     <delete path="${bundle.fileName}.tmp" />
   </install>
 </fragment>
```
How to override existing translations?

The same procedure as above can be used to override some existing translations. Just make sure you also require any bundle that would define them (like bundle "org.nuxeo.ecm.platform.lang.ext" above): the last definition in the file wins over the others.

Resolution Order

621

The resolution order represents the order in which this bundle's single component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).

Components

org.nuxeo.ecm.platform.ui.web.login.lang.ext

Maven Artifact

File	nuxeo-platform-lang-ext-2023.9.10.jar
Group Id	org.nuxeo.ecm.platform
Artifact Id	nuxeo-platform-lang-ext
Version	2023.9.10

Manifest

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven 3.6.1
Built-By: root
Build-Jdk: 17.0.10
Bundle-ManifestVersion: 1
Bundle-Version: 2023.9.10-t20240314-014459
Bundle-Name: Nuxeo ECM Language Extensions pack
Bundle-SymbolicName: org.nuxeo.ecm.platform.lang.ext
Bundle-Vendor: Nuxeo
Bundle-Category: stateless,web
Nuxeo-Component: OSGI-INF/login-screen-config.xml

Exports

Json Export Default Json serialization
Json Graph Json dependency graph
Json Contribution Stats Json statistics for contributions
CSV Contribution Stats CSV statistics for contributions

Charts

Raw Data: Json Contribution Stats

Contributions by Code Type

Loading data

Contributions by Target Extension Point

Loading data

Contributions by Studio Source

Loading data